-
Notifications
You must be signed in to change notification settings - Fork 198
Add Painless debugging section #4784
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Vale Linting ResultsSummary: 2 suggestions found 💡 Suggestions (2)
The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
yetanothertw
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this Debugging section works so well! Great idea 👏
Thanks for incorporating the notes sections into the intros, the information flows much better IMHO. 🎉
Summary
This replaces the Painless section that was proposed for the Troubleshooting section of the docs, to instead be a Debugging Painless scripts section in the Explore & Analyze Painless docs.
To my mind, this has two advantages:
Preview: Please see Debug Painless scripts in Elasticsearch and all sub-topics.
@yetanothertw I made changes as we talked about, except that I didn't move the "root cause" sections. As I read through I realized that these are specific to each example, so they wouldn't make sense where the description is. But, I have moved the "Notes" sections to be part of the descriptions at the top of each page (above the fold).
Generative AI disclosure